Enrol an eIDAS QWAC/QSealC certificate-bearing participant onto the Open Banking Directory. Currenty only TPPs can use this enrolment endpoint, so please set `OrganisationType` to `tpp`
curl -X POST "https://localhost:8080/open-banking/v2.3/organisation/{OrganisationType}"
import com.laegler.openbanking.*;
import com.laegler.openbanking.auth.*;
import com.laegler.openbanking.model.*;
import com.laegler.openbanking.api.OrganisationsApi;
import java.io.File;
import java.util.*;
public class OrganisationsApiExample {
public static void main(String[] args) {
OrganisationsApi apiInstance = new OrganisationsApi();
String organisationType = organisationType_example; // String | OB Organisation Type
String organisationTypeForQSealCOnboarding = organisationTypeForQSealCOnboarding_example; // String | OB Organisation Type
EnrolSchema enrol = ; // EnrolSchema | The payload submitted when a TPP attempts to enrol with an eIDAS QWAC or QSealC certificate. It's format and contents will depend on the value of the `Content-Type` header: TPP onto the Open Banking Directory (required fields to be validated). For eIDAS QSealC-bearing TPPs use a signed JWT (JWS).
* __application/json__ -- a JSON payload for QWAC onboarding.
* __application/jwt__ -- a signed JWT (JWS) for QSealC onboarding.
* __application/jose__ -- same as __application/jwt__.
## QWAC-based Onboarding
Set `Content-Type` to `application/json` and send the payload conforming to the schema.
EXAMPLE REQUEST PAYLOAD FOR QWAC-BASED ONBOARDING
```
POST /organisation/tpp HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
{
"client_name": "string",
"scope": "string",
"token_endpoint_auth_method": "string",
"tls_client_auth_subject_dn": "string",
"grant_types": [
"string"
],
"token_endpoint_auth_signing_alg": "string"
}
```
## QSealC-based Onboarding
Set `Content-Type` to `application/jwt` or `application/jose` and send the payload conforming to the schema as a signed JWT.
The QSealC, the issuing certificate, and the root certificate (all in DER format) must be used as the items of the array, which forms the value of the `x5c` claim in the JWT header.
The JWT MUST be signed using the private key associated with the QSealC listed in the `x5c` claim in the header.
```
{
"typ": "JWT",
"alg": "ES256",
"kid": "ABCD1234",
"x5c": ["qsealc", "issuer certificate", "root certificate"]
}
{
"client_name": "string",
"scope": "string",
"token_endpoint_auth_method": "string",
"tls_client_auth_subject_dn": "string",
"grant_types": [
"string"
],
"token_endpoint_auth_signing_alg": "string"
}
```
EXAMPLE REQUEST PAYLOAD FOR QSealC-BASED ONBOARDING
```
POST /organisation/tpp HTTP/1.1
Content-Type: application/jwt | application/jose
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6IkFCQ0QxMjM0IiwieDVjIjpbInFzZWFsYyIsImlzc3VlciBjZXJ0aWZpY2F0ZSIsInJvb3QgY2VydGlmaWNhdGUiXX0.eyJyZWRpcmVjdF91cmlzIjpbInN0cmluZyJdLCJ0b2tlbl9lbmRwb2ludF9hdXRoX21ldGhvZCI6InN0cmluZyIsImdyYW50X3R5cGVzIjpbInN0cmluZyJdLCJyZXNwb25zZV90eXBlcyI6WyJzdHJpbmciXSwiY2xpZW50X25hbWUiOiJzdHJpbmciLCJjbGllbnRfdXJpIjoic3RyaW5nIiwibG9nb191cmkiOiJzdHJpbmciLCJzY29wZSI6InN0cmluZyIsImNvbnRhY3RzIjpbInVzZXJAZXhhbXBsZS5jb20iXSwidG9zX3VyaSI6InN0cmluZyIsInBvbGljeV91cmkiOiJzdHJpbmciLCJqd2tzX3VyaSI6InN0cmluZyIsImp3a3MiOnt9LCJzb2Z0d2FyZV9pZCI6InN0cmluZyIsInNvZnR3YXJlX3ZlcnNpb24iOiJzdHJpbmcifQ.lMsADSHkFGUw5PtgdEqXslYArzqf6tbg0lo0kCitOUA
```
try {
apiInstance.organisationOrganisationTypePost(organisationType, organisationTypeForQSealCOnboarding, enrol);
} catch (ApiException e) {
System.err.println("Exception when calling OrganisationsApi#organisationOrganisationTypePost");
e.printStackTrace();
}
}
}
import com.laegler.openbanking.api.OrganisationsApi;
public class OrganisationsApiExample {
public static void main(String[] args) {
OrganisationsApi apiInstance = new OrganisationsApi();
String organisationType = organisationType_example; // String | OB Organisation Type
String organisationTypeForQSealCOnboarding = organisationTypeForQSealCOnboarding_example; // String | OB Organisation Type
EnrolSchema enrol = ; // EnrolSchema | The payload submitted when a TPP attempts to enrol with an eIDAS QWAC or QSealC certificate. It's format and contents will depend on the value of the `Content-Type` header: TPP onto the Open Banking Directory (required fields to be validated). For eIDAS QSealC-bearing TPPs use a signed JWT (JWS).
* __application/json__ -- a JSON payload for QWAC onboarding.
* __application/jwt__ -- a signed JWT (JWS) for QSealC onboarding.
* __application/jose__ -- same as __application/jwt__.
## QWAC-based Onboarding
Set `Content-Type` to `application/json` and send the payload conforming to the schema.
EXAMPLE REQUEST PAYLOAD FOR QWAC-BASED ONBOARDING
```
POST /organisation/tpp HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
{
"client_name": "string",
"scope": "string",
"token_endpoint_auth_method": "string",
"tls_client_auth_subject_dn": "string",
"grant_types": [
"string"
],
"token_endpoint_auth_signing_alg": "string"
}
```
## QSealC-based Onboarding
Set `Content-Type` to `application/jwt` or `application/jose` and send the payload conforming to the schema as a signed JWT.
The QSealC, the issuing certificate, and the root certificate (all in DER format) must be used as the items of the array, which forms the value of the `x5c` claim in the JWT header.
The JWT MUST be signed using the private key associated with the QSealC listed in the `x5c` claim in the header.
```
{
"typ": "JWT",
"alg": "ES256",
"kid": "ABCD1234",
"x5c": ["qsealc", "issuer certificate", "root certificate"]
}
{
"client_name": "string",
"scope": "string",
"token_endpoint_auth_method": "string",
"tls_client_auth_subject_dn": "string",
"grant_types": [
"string"
],
"token_endpoint_auth_signing_alg": "string"
}
```
EXAMPLE REQUEST PAYLOAD FOR QSealC-BASED ONBOARDING
```
POST /organisation/tpp HTTP/1.1
Content-Type: application/jwt | application/jose
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6IkFCQ0QxMjM0IiwieDVjIjpbInFzZWFsYyIsImlzc3VlciBjZXJ0aWZpY2F0ZSIsInJvb3QgY2VydGlmaWNhdGUiXX0.eyJyZWRpcmVjdF91cmlzIjpbInN0cmluZyJdLCJ0b2tlbl9lbmRwb2ludF9hdXRoX21ldGhvZCI6InN0cmluZyIsImdyYW50X3R5cGVzIjpbInN0cmluZyJdLCJyZXNwb25zZV90eXBlcyI6WyJzdHJpbmciXSwiY2xpZW50X25hbWUiOiJzdHJpbmciLCJjbGllbnRfdXJpIjoic3RyaW5nIiwibG9nb191cmkiOiJzdHJpbmciLCJzY29wZSI6InN0cmluZyIsImNvbnRhY3RzIjpbInVzZXJAZXhhbXBsZS5jb20iXSwidG9zX3VyaSI6InN0cmluZyIsInBvbGljeV91cmkiOiJzdHJpbmciLCJqd2tzX3VyaSI6InN0cmluZyIsImp3a3MiOnt9LCJzb2Z0d2FyZV9pZCI6InN0cmluZyIsInNvZnR3YXJlX3ZlcnNpb24iOiJzdHJpbmcifQ.lMsADSHkFGUw5PtgdEqXslYArzqf6tbg0lo0kCitOUA
```
try {
apiInstance.organisationOrganisationTypePost(organisationType, organisationTypeForQSealCOnboarding, enrol);
} catch (ApiException e) {
System.err.println("Exception when calling OrganisationsApi#organisationOrganisationTypePost");
e.printStackTrace();
}
}
}
String *organisationType = organisationType_example; // OB Organisation Type
String *organisationTypeForQSealCOnboarding = organisationTypeForQSealCOnboarding_example; // OB Organisation Type
EnrolSchema *enrol = ; // The payload submitted when a TPP attempts to enrol with an eIDAS QWAC or QSealC certificate. It's format and contents will depend on the value of the `Content-Type` header: TPP onto the Open Banking Directory (required fields to be validated). For eIDAS QSealC-bearing TPPs use a signed JWT (JWS).
* __application/json__ -- a JSON payload for QWAC onboarding.
* __application/jwt__ -- a signed JWT (JWS) for QSealC onboarding.
* __application/jose__ -- same as __application/jwt__.
## QWAC-based Onboarding
Set `Content-Type` to `application/json` and send the payload conforming to the schema.
EXAMPLE REQUEST PAYLOAD FOR QWAC-BASED ONBOARDING
```
POST /organisation/tpp HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
{
"client_name": "string",
"scope": "string",
"token_endpoint_auth_method": "string",
"tls_client_auth_subject_dn": "string",
"grant_types": [
"string"
],
"token_endpoint_auth_signing_alg": "string"
}
```
## QSealC-based Onboarding
Set `Content-Type` to `application/jwt` or `application/jose` and send the payload conforming to the schema as a signed JWT.
The QSealC, the issuing certificate, and the root certificate (all in DER format) must be used as the items of the array, which forms the value of the `x5c` claim in the JWT header.
The JWT MUST be signed using the private key associated with the QSealC listed in the `x5c` claim in the header.
```
{
"typ": "JWT",
"alg": "ES256",
"kid": "ABCD1234",
"x5c": ["qsealc", "issuer certificate", "root certificate"]
}
{
"client_name": "string",
"scope": "string",
"token_endpoint_auth_method": "string",
"tls_client_auth_subject_dn": "string",
"grant_types": [
"string"
],
"token_endpoint_auth_signing_alg": "string"
}
```
EXAMPLE REQUEST PAYLOAD FOR QSealC-BASED ONBOARDING
```
POST /organisation/tpp HTTP/1.1
Content-Type: application/jwt | application/jose
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6IkFCQ0QxMjM0IiwieDVjIjpbInFzZWFsYyIsImlzc3VlciBjZXJ0aWZpY2F0ZSIsInJvb3QgY2VydGlmaWNhdGUiXX0.eyJyZWRpcmVjdF91cmlzIjpbInN0cmluZyJdLCJ0b2tlbl9lbmRwb2ludF9hdXRoX21ldGhvZCI6InN0cmluZyIsImdyYW50X3R5cGVzIjpbInN0cmluZyJdLCJyZXNwb25zZV90eXBlcyI6WyJzdHJpbmciXSwiY2xpZW50X25hbWUiOiJzdHJpbmciLCJjbGllbnRfdXJpIjoic3RyaW5nIiwibG9nb191cmkiOiJzdHJpbmciLCJzY29wZSI6InN0cmluZyIsImNvbnRhY3RzIjpbInVzZXJAZXhhbXBsZS5jb20iXSwidG9zX3VyaSI6InN0cmluZyIsInBvbGljeV91cmkiOiJzdHJpbmciLCJqd2tzX3VyaSI6InN0cmluZyIsImp3a3MiOnt9LCJzb2Z0d2FyZV9pZCI6InN0cmluZyIsInNvZnR3YXJlX3ZlcnNpb24iOiJzdHJpbmcifQ.lMsADSHkFGUw5PtgdEqXslYArzqf6tbg0lo0kCitOUA
```
OrganisationsApi *apiInstance = [[OrganisationsApi alloc] init];
// Enrol a eIDAS QWAC/QSealC-bearing participant
[apiInstance organisationOrganisationTypePostWith:organisationType
organisationTypeForQSealCOnboarding:organisationTypeForQSealCOnboarding
enrol:enrol
completionHandler: ^(NSError* error) {
if (error) {
NSLog(@"Error: %@", error);
}
}];
var OpenBankingApi = require('open_banking_api');
var api = new OpenBankingApi.OrganisationsApi()
var organisationType = organisationType_example; // {String} OB Organisation Type
var organisationTypeForQSealCOnboarding = organisationTypeForQSealCOnboarding_example; // {String} OB Organisation Type
var enrol = ; // {EnrolSchema} The payload submitted when a TPP attempts to enrol with an eIDAS QWAC or QSealC certificate. It's format and contents will depend on the value of the `Content-Type` header: TPP onto the Open Banking Directory (required fields to be validated). For eIDAS QSealC-bearing TPPs use a signed JWT (JWS).
* __application/json__ -- a JSON payload for QWAC onboarding.
* __application/jwt__ -- a signed JWT (JWS) for QSealC onboarding.
* __application/jose__ -- same as __application/jwt__.
## QWAC-based Onboarding
Set `Content-Type` to `application/json` and send the payload conforming to the schema.
EXAMPLE REQUEST PAYLOAD FOR QWAC-BASED ONBOARDING
```
POST /organisation/tpp HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
{
"client_name": "string",
"scope": "string",
"token_endpoint_auth_method": "string",
"tls_client_auth_subject_dn": "string",
"grant_types": [
"string"
],
"token_endpoint_auth_signing_alg": "string"
}
```
## QSealC-based Onboarding
Set `Content-Type` to `application/jwt` or `application/jose` and send the payload conforming to the schema as a signed JWT.
The QSealC, the issuing certificate, and the root certificate (all in DER format) must be used as the items of the array, which forms the value of the `x5c` claim in the JWT header.
The JWT MUST be signed using the private key associated with the QSealC listed in the `x5c` claim in the header.
```
{
"typ": "JWT",
"alg": "ES256",
"kid": "ABCD1234",
"x5c": ["qsealc", "issuer certificate", "root certificate"]
}
{
"client_name": "string",
"scope": "string",
"token_endpoint_auth_method": "string",
"tls_client_auth_subject_dn": "string",
"grant_types": [
"string"
],
"token_endpoint_auth_signing_alg": "string"
}
```
EXAMPLE REQUEST PAYLOAD FOR QSealC-BASED ONBOARDING
```
POST /organisation/tpp HTTP/1.1
Content-Type: application/jwt | application/jose
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6IkFCQ0QxMjM0IiwieDVjIjpbInFzZWFsYyIsImlzc3VlciBjZXJ0aWZpY2F0ZSIsInJvb3QgY2VydGlmaWNhdGUiXX0.eyJyZWRpcmVjdF91cmlzIjpbInN0cmluZyJdLCJ0b2tlbl9lbmRwb2ludF9hdXRoX21ldGhvZCI6InN0cmluZyIsImdyYW50X3R5cGVzIjpbInN0cmluZyJdLCJyZXNwb25zZV90eXBlcyI6WyJzdHJpbmciXSwiY2xpZW50X25hbWUiOiJzdHJpbmciLCJjbGllbnRfdXJpIjoic3RyaW5nIiwibG9nb191cmkiOiJzdHJpbmciLCJzY29wZSI6InN0cmluZyIsImNvbnRhY3RzIjpbInVzZXJAZXhhbXBsZS5jb20iXSwidG9zX3VyaSI6InN0cmluZyIsInBvbGljeV91cmkiOiJzdHJpbmciLCJqd2tzX3VyaSI6InN0cmluZyIsImp3a3MiOnt9LCJzb2Z0d2FyZV9pZCI6InN0cmluZyIsInNvZnR3YXJlX3ZlcnNpb24iOiJzdHJpbmcifQ.lMsADSHkFGUw5PtgdEqXslYArzqf6tbg0lo0kCitOUA
```
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.organisationOrganisationTypePost(organisationType, organisationTypeForQSealCOnboarding, enrol, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class organisationOrganisationTypePostExample
{
public void main()
{
var apiInstance = new OrganisationsApi();
var organisationType = organisationType_example; // String | OB Organisation Type
var organisationTypeForQSealCOnboarding = organisationTypeForQSealCOnboarding_example; // String | OB Organisation Type
var enrol = new EnrolSchema(); // EnrolSchema | The payload submitted when a TPP attempts to enrol with an eIDAS QWAC or QSealC certificate. It's format and contents will depend on the value of the `Content-Type` header: TPP onto the Open Banking Directory (required fields to be validated). For eIDAS QSealC-bearing TPPs use a signed JWT (JWS).
* __application/json__ -- a JSON payload for QWAC onboarding.
* __application/jwt__ -- a signed JWT (JWS) for QSealC onboarding.
* __application/jose__ -- same as __application/jwt__.
## QWAC-based Onboarding
Set `Content-Type` to `application/json` and send the payload conforming to the schema.
EXAMPLE REQUEST PAYLOAD FOR QWAC-BASED ONBOARDING
```
POST /organisation/tpp HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
{
"client_name": "string",
"scope": "string",
"token_endpoint_auth_method": "string",
"tls_client_auth_subject_dn": "string",
"grant_types": [
"string"
],
"token_endpoint_auth_signing_alg": "string"
}
```
## QSealC-based Onboarding
Set `Content-Type` to `application/jwt` or `application/jose` and send the payload conforming to the schema as a signed JWT.
The QSealC, the issuing certificate, and the root certificate (all in DER format) must be used as the items of the array, which forms the value of the `x5c` claim in the JWT header.
The JWT MUST be signed using the private key associated with the QSealC listed in the `x5c` claim in the header.
```
{
"typ": "JWT",
"alg": "ES256",
"kid": "ABCD1234",
"x5c": ["qsealc", "issuer certificate", "root certificate"]
}
{
"client_name": "string",
"scope": "string",
"token_endpoint_auth_method": "string",
"tls_client_auth_subject_dn": "string",
"grant_types": [
"string"
],
"token_endpoint_auth_signing_alg": "string"
}
```
EXAMPLE REQUEST PAYLOAD FOR QSealC-BASED ONBOARDING
```
POST /organisation/tpp HTTP/1.1
Content-Type: application/jwt | application/jose
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6IkFCQ0QxMjM0IiwieDVjIjpbInFzZWFsYyIsImlzc3VlciBjZXJ0aWZpY2F0ZSIsInJvb3QgY2VydGlmaWNhdGUiXX0.eyJyZWRpcmVjdF91cmlzIjpbInN0cmluZyJdLCJ0b2tlbl9lbmRwb2ludF9hdXRoX21ldGhvZCI6InN0cmluZyIsImdyYW50X3R5cGVzIjpbInN0cmluZyJdLCJyZXNwb25zZV90eXBlcyI6WyJzdHJpbmciXSwiY2xpZW50X25hbWUiOiJzdHJpbmciLCJjbGllbnRfdXJpIjoic3RyaW5nIiwibG9nb191cmkiOiJzdHJpbmciLCJzY29wZSI6InN0cmluZyIsImNvbnRhY3RzIjpbInVzZXJAZXhhbXBsZS5jb20iXSwidG9zX3VyaSI6InN0cmluZyIsInBvbGljeV91cmkiOiJzdHJpbmciLCJqd2tzX3VyaSI6InN0cmluZyIsImp3a3MiOnt9LCJzb2Z0d2FyZV9pZCI6InN0cmluZyIsInNvZnR3YXJlX3ZlcnNpb24iOiJzdHJpbmcifQ.lMsADSHkFGUw5PtgdEqXslYArzqf6tbg0lo0kCitOUA
```
try
{
// Enrol a eIDAS QWAC/QSealC-bearing participant
apiInstance.organisationOrganisationTypePost(organisationType, organisationTypeForQSealCOnboarding, enrol);
}
catch (Exception e)
{
Debug.Print("Exception when calling OrganisationsApi.organisationOrganisationTypePost: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\OrganisationsApi();
$organisationType = organisationType_example; // String | OB Organisation Type
$organisationTypeForQSealCOnboarding = organisationTypeForQSealCOnboarding_example; // String | OB Organisation Type
$enrol = ; // EnrolSchema | The payload submitted when a TPP attempts to enrol with an eIDAS QWAC or QSealC certificate. It's format and contents will depend on the value of the `Content-Type` header: TPP onto the Open Banking Directory (required fields to be validated). For eIDAS QSealC-bearing TPPs use a signed JWT (JWS).
* __application/json__ -- a JSON payload for QWAC onboarding.
* __application/jwt__ -- a signed JWT (JWS) for QSealC onboarding.
* __application/jose__ -- same as __application/jwt__.
## QWAC-based Onboarding
Set `Content-Type` to `application/json` and send the payload conforming to the schema.
EXAMPLE REQUEST PAYLOAD FOR QWAC-BASED ONBOARDING
```
POST /organisation/tpp HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
{
"client_name": "string",
"scope": "string",
"token_endpoint_auth_method": "string",
"tls_client_auth_subject_dn": "string",
"grant_types": [
"string"
],
"token_endpoint_auth_signing_alg": "string"
}
```
## QSealC-based Onboarding
Set `Content-Type` to `application/jwt` or `application/jose` and send the payload conforming to the schema as a signed JWT.
The QSealC, the issuing certificate, and the root certificate (all in DER format) must be used as the items of the array, which forms the value of the `x5c` claim in the JWT header.
The JWT MUST be signed using the private key associated with the QSealC listed in the `x5c` claim in the header.
```
{
"typ": "JWT",
"alg": "ES256",
"kid": "ABCD1234",
"x5c": ["qsealc", "issuer certificate", "root certificate"]
}
{
"client_name": "string",
"scope": "string",
"token_endpoint_auth_method": "string",
"tls_client_auth_subject_dn": "string",
"grant_types": [
"string"
],
"token_endpoint_auth_signing_alg": "string"
}
```
EXAMPLE REQUEST PAYLOAD FOR QSealC-BASED ONBOARDING
```
POST /organisation/tpp HTTP/1.1
Content-Type: application/jwt | application/jose
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6IkFCQ0QxMjM0IiwieDVjIjpbInFzZWFsYyIsImlzc3VlciBjZXJ0aWZpY2F0ZSIsInJvb3QgY2VydGlmaWNhdGUiXX0.eyJyZWRpcmVjdF91cmlzIjpbInN0cmluZyJdLCJ0b2tlbl9lbmRwb2ludF9hdXRoX21ldGhvZCI6InN0cmluZyIsImdyYW50X3R5cGVzIjpbInN0cmluZyJdLCJyZXNwb25zZV90eXBlcyI6WyJzdHJpbmciXSwiY2xpZW50X25hbWUiOiJzdHJpbmciLCJjbGllbnRfdXJpIjoic3RyaW5nIiwibG9nb191cmkiOiJzdHJpbmciLCJzY29wZSI6InN0cmluZyIsImNvbnRhY3RzIjpbInVzZXJAZXhhbXBsZS5jb20iXSwidG9zX3VyaSI6InN0cmluZyIsInBvbGljeV91cmkiOiJzdHJpbmciLCJqd2tzX3VyaSI6InN0cmluZyIsImp3a3MiOnt9LCJzb2Z0d2FyZV9pZCI6InN0cmluZyIsInNvZnR3YXJlX3ZlcnNpb24iOiJzdHJpbmcifQ.lMsADSHkFGUw5PtgdEqXslYArzqf6tbg0lo0kCitOUA
```
try {
$api_instance->organisationOrganisationTypePost($organisationType, $organisationTypeForQSealCOnboarding, $enrol);
} catch (Exception $e) {
echo 'Exception when calling OrganisationsApi->organisationOrganisationTypePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrganisationsApi;
my $api_instance = WWW::SwaggerClient::OrganisationsApi->new();
my $organisationType = organisationType_example; # String | OB Organisation Type
my $organisationTypeForQSealCOnboarding = organisationTypeForQSealCOnboarding_example; # String | OB Organisation Type
my $enrol = WWW::SwaggerClient::Object::EnrolSchema->new(); # EnrolSchema | The payload submitted when a TPP attempts to enrol with an eIDAS QWAC or QSealC certificate. It's format and contents will depend on the value of the `Content-Type` header: TPP onto the Open Banking Directory (required fields to be validated). For eIDAS QSealC-bearing TPPs use a signed JWT (JWS).
* __application/json__ -- a JSON payload for QWAC onboarding.
* __application/jwt__ -- a signed JWT (JWS) for QSealC onboarding.
* __application/jose__ -- same as __application/jwt__.
## QWAC-based Onboarding
Set `Content-Type` to `application/json` and send the payload conforming to the schema.
EXAMPLE REQUEST PAYLOAD FOR QWAC-BASED ONBOARDING
```
POST /organisation/tpp HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
{
"client_name": "string",
"scope": "string",
"token_endpoint_auth_method": "string",
"tls_client_auth_subject_dn": "string",
"grant_types": [
"string"
],
"token_endpoint_auth_signing_alg": "string"
}
```
## QSealC-based Onboarding
Set `Content-Type` to `application/jwt` or `application/jose` and send the payload conforming to the schema as a signed JWT.
The QSealC, the issuing certificate, and the root certificate (all in DER format) must be used as the items of the array, which forms the value of the `x5c` claim in the JWT header.
The JWT MUST be signed using the private key associated with the QSealC listed in the `x5c` claim in the header.
```
{
"typ": "JWT",
"alg": "ES256",
"kid": "ABCD1234",
"x5c": ["qsealc", "issuer certificate", "root certificate"]
}
{
"client_name": "string",
"scope": "string",
"token_endpoint_auth_method": "string",
"tls_client_auth_subject_dn": "string",
"grant_types": [
"string"
],
"token_endpoint_auth_signing_alg": "string"
}
```
EXAMPLE REQUEST PAYLOAD FOR QSealC-BASED ONBOARDING
```
POST /organisation/tpp HTTP/1.1
Content-Type: application/jwt | application/jose
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6IkFCQ0QxMjM0IiwieDVjIjpbInFzZWFsYyIsImlzc3VlciBjZXJ0aWZpY2F0ZSIsInJvb3QgY2VydGlmaWNhdGUiXX0.eyJyZWRpcmVjdF91cmlzIjpbInN0cmluZyJdLCJ0b2tlbl9lbmRwb2ludF9hdXRoX21ldGhvZCI6InN0cmluZyIsImdyYW50X3R5cGVzIjpbInN0cmluZyJdLCJyZXNwb25zZV90eXBlcyI6WyJzdHJpbmciXSwiY2xpZW50X25hbWUiOiJzdHJpbmciLCJjbGllbnRfdXJpIjoic3RyaW5nIiwibG9nb191cmkiOiJzdHJpbmciLCJzY29wZSI6InN0cmluZyIsImNvbnRhY3RzIjpbInVzZXJAZXhhbXBsZS5jb20iXSwidG9zX3VyaSI6InN0cmluZyIsInBvbGljeV91cmkiOiJzdHJpbmciLCJqd2tzX3VyaSI6InN0cmluZyIsImp3a3MiOnt9LCJzb2Z0d2FyZV9pZCI6InN0cmluZyIsInNvZnR3YXJlX3ZlcnNpb24iOiJzdHJpbmcifQ.lMsADSHkFGUw5PtgdEqXslYArzqf6tbg0lo0kCitOUA
```
eval {
$api_instance->organisationOrganisationTypePost(organisationType => $organisationType, organisationTypeForQSealCOnboarding => $organisationTypeForQSealCOnboarding, enrol => $enrol);
};
if ($@) {
warn "Exception when calling OrganisationsApi->organisationOrganisationTypePost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.OrganisationsApi()
organisationType = organisationType_example # String | OB Organisation Type
organisationTypeForQSealCOnboarding = organisationTypeForQSealCOnboarding_example # String | OB Organisation Type
enrol = # EnrolSchema | The payload submitted when a TPP attempts to enrol with an eIDAS QWAC or QSealC certificate. It's format and contents will depend on the value of the `Content-Type` header: TPP onto the Open Banking Directory (required fields to be validated). For eIDAS QSealC-bearing TPPs use a signed JWT (JWS).
* __application/json__ -- a JSON payload for QWAC onboarding.
* __application/jwt__ -- a signed JWT (JWS) for QSealC onboarding.
* __application/jose__ -- same as __application/jwt__.
## QWAC-based Onboarding
Set `Content-Type` to `application/json` and send the payload conforming to the schema.
EXAMPLE REQUEST PAYLOAD FOR QWAC-BASED ONBOARDING
```
POST /organisation/tpp HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
{
"client_name": "string",
"scope": "string",
"token_endpoint_auth_method": "string",
"tls_client_auth_subject_dn": "string",
"grant_types": [
"string"
],
"token_endpoint_auth_signing_alg": "string"
}
```
## QSealC-based Onboarding
Set `Content-Type` to `application/jwt` or `application/jose` and send the payload conforming to the schema as a signed JWT.
The QSealC, the issuing certificate, and the root certificate (all in DER format) must be used as the items of the array, which forms the value of the `x5c` claim in the JWT header.
The JWT MUST be signed using the private key associated with the QSealC listed in the `x5c` claim in the header.
```
{
"typ": "JWT",
"alg": "ES256",
"kid": "ABCD1234",
"x5c": ["qsealc", "issuer certificate", "root certificate"]
}
{
"client_name": "string",
"scope": "string",
"token_endpoint_auth_method": "string",
"tls_client_auth_subject_dn": "string",
"grant_types": [
"string"
],
"token_endpoint_auth_signing_alg": "string"
}
```
EXAMPLE REQUEST PAYLOAD FOR QSealC-BASED ONBOARDING
```
POST /organisation/tpp HTTP/1.1
Content-Type: application/jwt | application/jose
Accept: application/json
Host: matls-dirapi.openbanking.org.uk
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6IkFCQ0QxMjM0IiwieDVjIjpbInFzZWFsYyIsImlzc3VlciBjZXJ0aWZpY2F0ZSIsInJvb3QgY2VydGlmaWNhdGUiXX0.eyJyZWRpcmVjdF91cmlzIjpbInN0cmluZyJdLCJ0b2tlbl9lbmRwb2ludF9hdXRoX21ldGhvZCI6InN0cmluZyIsImdyYW50X3R5cGVzIjpbInN0cmluZyJdLCJyZXNwb25zZV90eXBlcyI6WyJzdHJpbmciXSwiY2xpZW50X25hbWUiOiJzdHJpbmciLCJjbGllbnRfdXJpIjoic3RyaW5nIiwibG9nb191cmkiOiJzdHJpbmciLCJzY29wZSI6InN0cmluZyIsImNvbnRhY3RzIjpbInVzZXJAZXhhbXBsZS5jb20iXSwidG9zX3VyaSI6InN0cmluZyIsInBvbGljeV91cmkiOiJzdHJpbmciLCJqd2tzX3VyaSI6InN0cmluZyIsImp3a3MiOnt9LCJzb2Z0d2FyZV9pZCI6InN0cmluZyIsInNvZnR3YXJlX3ZlcnNpb24iOiJzdHJpbmcifQ.lMsADSHkFGUw5PtgdEqXslYArzqf6tbg0lo0kCitOUA
```
try:
# Enrol a eIDAS QWAC/QSealC-bearing participant
api_instance.organisation_organisation_type_post(organisationType, organisationTypeForQSealCOnboarding, enrol)
except ApiException as e:
print("Exception when calling OrganisationsApi->organisationOrganisationTypePost: %s\n" % e)